﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

// Reviewed
#pragma once

#include "GcmpModelInterface.h"
#include "INoElementIdDbObject.h"
#include "NdbObjectSchematic.h"
#include "DbDataSchema.h"

namespace gcmp {
    class IElement;
    class ICurve3d;
    class IPlane;

    /// \brief 对象的偏移组件的接口。
    class GCMP_MODEL_INTERFACE_EXPORT IElementOffsetComponent : public INoElementIdDbObject
    {
        DEFINE_CAST_DERIVED(gcmp::IElementOffsetComponent, gcmp::INoElementIdDbObject)

    public:
        /// \brief 生成默认的偏移组件的实现
        ///
        /// 目前和空的偏移组件一致,没有具体的偏移逻辑
        /// \param pElement 接口所属的对象
        /// \return 返回一个接口的指针。
        static OwnerPtr<IElementOffsetComponent> CreateNoOffsetComponent();

        /// \brief 生成空的偏移组件的实现
        ///
        /// 没有具体的偏移逻辑
        /// \param pElement 接口所属的对象
        /// \return 返回一个接口的指针。
        static OwnerPtr<IElementOffsetComponent> CreateNullOffsetComponent();

        /// \brief 对象的是否可偏移。
        /// \param explanation 不可偏移时，可以返回原因。
        /// \return 可偏移则返回true；否则返回false。
        virtual bool CanBeOffset(std::wstring* explanation) const = 0;

        /// \brief 对象的是否可以相连偏移。
        /// \return 可相连偏移则返回true；否则返回false。
        virtual bool CanBeOffsetConnected() const = 0;

        /// \brief 获取可以相连偏移的对象。
        ///
        /// \return 返回所有可以相连偏移的对象的Id。
        virtual ElementIdArray GetElementsCanBeOffsetConnected() const = 0;

        /// \brief 获取对象偏移操作的基准曲线。
        /// \param pBasePlane 偏移的基准平面。
        /// \return 返回对象偏移操作的基准曲线。
        GCMP_DEPRECATED_API(2021 / 04 / 01) virtual OwnerPtr<ICurve3d> GetOffsetBaseCurve(const IPlane* pBasePlane) const = 0;

        /// \brief 设置对象偏移操作后的基准曲线。
        /// \param pBasePlane 偏移的基准平面。
        /// \param pCurve 偏移后的基准曲线。
        /// \return 设置成功则返回true；否则返回false。
        GCMP_DEPRECATED_API(2021 / 04 / 01) virtual bool SetOffsetBaseCurve(const IPlane* pBasePlane, const ICurve3d *pCurve) = 0;

        /// \brief 获取对象偏移操作的基准曲线。
        /// \param pBasePlane 偏移的基准平面。
        /// \return 返回对象偏移操作的基准曲线。
        virtual std::vector<OwnerPtr<ICurve3d>> GetOffsetBaseCurves(const IPlane* pBasePlane) const = 0;

        /// \brief 设置对象偏移操作后的基准曲线。
        /// \param pBasePlane 偏移的基准平面。
        /// \param vCurves 偏移后的基准曲线。
        /// \return 设置成功则返回true；否则返回false。
        virtual bool SetOffsetBaseCurves(const IPlane* pBasePlane, const std::vector<const ICurve3d *>& vCurves) = 0;
    };

}// namespace gcmp


